com.doclinx.jftr
Class NodeInfo

java.lang.Object
  |
  +--com.doclinx.jftr.NodeInfo

public class NodeInfo
extends java.lang.Object

Class describing Query tree node data.


Field Summary
 int ni_docCount
          Total number of documents located using term.
 int ni_dri
          DRI of node.
 boolean ni_leaf
          Is node a leaf (i.e. hold a symbol).
 int ni_next
          Node sibling (or parent)
 int ni_order
          In exact phrase, order index of phrase term
 int ni_subType
          Node sub-type (for range or bound terms)
 java.lang.String ni_symbol
          Query search symbol (if a terminal node)
 java.lang.String ni_symbolUpper
          Query search symbol when doing bounds (e.g. field 8 BETWEEN a,b).
 int ni_symCount
          Total number of dictionary entries for symbol.
 int ni_type
          Node type
static java.lang.String SEP
          Default separator String for phrases.
 
Constructor Summary
protected NodeInfo()
          Hidden default constructor.
  NodeInfo(java.util.Vector v, int i)
          Constructor taking query tree and index into tree.
 
Method Summary
 int getCount()
           
 int getDocCount()
           
 java.lang.String[] getRangeSymbols()
          Returns String array of 2 with lower and upper symbol for range.
 java.lang.String getSymbol()
          Returns String word symbol for terminal node.
 java.lang.String getSymbolUpper()
          Returns String upper word symbol for range terms.
 boolean isPhrase()
          Is node used in an exact order phrase?
 boolean isPhraseStart()
          Is node 1st term of an exact order phrase?
 boolean isRange()
          Is node a range node?
 boolean isTerminal()
          Is node a terminal (leaf) node?
 void merge(com.doclinx.jftr.NodeInfo ni)
          Merge two nodes counting values.
static com.doclinx.jftr.NodeInfo[] niFactory(java.util.Vector v)
          Factory method to create NodeInfo array from query tree.
static java.util.Vector niFactoryDictItemTerms(java.util.Vector v)
           
static void niFactoryDictItemTerms(java.util.Vector v, java.util.Vector out)
          Factory method to create Vector of DictItems (symbols/counts) from query tree.
static java.util.Vector niFactoryStringTerms(java.util.Vector v)
           
static void niFactoryStringTerms(java.util.Vector v, java.util.Vector out)
          Factory method to create Vector of String symbols from query tree.
static java.util.Vector niFactoryStringTermsAndPhrases(java.util.Vector v)
           
static void niFactoryStringTermsAndPhrases(java.util.Vector v, java.lang.String sep, java.util.Vector out)
          Factory method to create Vector of String symbols and phrases from query tree.
static void niFactoryStringTermsAndPhrases(java.util.Vector v, java.util.Vector out)
          Factory method to create Vector of String symbols and phrases from query tree.
static void niFactoryTerms(java.util.Vector v, java.util.Vector out)
          Factory method to create Vector of NodeInfo objects from query tree.
static void niMerge(java.util.Vector v1, java.util.Vector v2)
          Merges two NodeInfo or Symbol Vectors.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SEP

public static java.lang.String SEP
Default separator String for phrases.


ni_symbol

public java.lang.String ni_symbol
Query search symbol (if a terminal node)


ni_symbolUpper

public java.lang.String ni_symbolUpper
Query search symbol when doing bounds (e.g. field 8 BETWEEN a,b).


ni_next

public int ni_next
Node sibling (or parent)


ni_order

public int ni_order
In exact phrase, order index of phrase term


ni_type

public int ni_type
Node type


ni_subType

public int ni_subType
Node sub-type (for range or bound terms)


ni_symCount

public int ni_symCount
Total number of dictionary entries for symbol.


ni_docCount

public int ni_docCount
Total number of documents located using term.


ni_leaf

public boolean ni_leaf
Is node a leaf (i.e. hold a symbol).


ni_dri

public int ni_dri
DRI of node.

Constructor Detail

NodeInfo

protected NodeInfo()
Hidden default constructor.


NodeInfo

public NodeInfo(java.util.Vector v,
                int i)
Constructor taking query tree and index into tree.

Method Detail

getCount

public int getCount()

getDocCount

public int getDocCount()

isTerminal

public boolean isTerminal()
Is node a terminal (leaf) node?

Returns:
true if node is a leaf.

isRange

public boolean isRange()
Is node a range node?

Returns:
true if node if subType indicates node is a range operation.

isPhrase

public boolean isPhrase()
Is node used in an exact order phrase?

Returns:
true if node starts an exact order term.

isPhraseStart

public boolean isPhraseStart()
Is node 1st term of an exact order phrase?

Returns:
true if node node is the 1st term.

getSymbol

public java.lang.String getSymbol()
Returns String word symbol for terminal node.

Returns:
String symbol.

getSymbolUpper

public java.lang.String getSymbolUpper()
Returns String upper word symbol for range terms.

Returns:
String symbol.

getRangeSymbols

public java.lang.String[] getRangeSymbols()
Returns String array of 2 with lower and upper symbol for range.

Returns:
String[] symbols.

merge

public void merge(com.doclinx.jftr.NodeInfo ni)
Merge two nodes counting values.


niMerge

public static void niMerge(java.util.Vector v1,
                           java.util.Vector v2)
Merges two NodeInfo or Symbol Vectors.


niFactory

public static com.doclinx.jftr.NodeInfo[] niFactory(java.util.Vector v)
Factory method to create NodeInfo array from query tree.

Parameters:
v - Vector containing query parse tree.
Returns:
NodeInfo array corresponding to query tree objects.

niFactoryTerms

public static void niFactoryTerms(java.util.Vector v,
                                  java.util.Vector out)
Factory method to create Vector of NodeInfo objects from query tree.

Parameters:
v - Vector containing query parse tree.
out - Vector contaings resulting NodeInfo objects.

niFactoryStringTerms

public static void niFactoryStringTerms(java.util.Vector v,
                                        java.util.Vector out)
Factory method to create Vector of String symbols from query tree.
 NOTE: Only symbols in DRI 0 are returned.

Parameters:
v - Vector containing query parse tree. (or NodeInfo's)
out - Vector contaings resulting String symbols.

niFactoryStringTerms

public static java.util.Vector niFactoryStringTerms(java.util.Vector v)

niFactoryDictItemTerms

public static void niFactoryDictItemTerms(java.util.Vector v,
                                          java.util.Vector out)
Factory method to create Vector of DictItems (symbols/counts) from query tree. (Note separator in phrases defaults to ' ')

Parameters:
v - Vector containing query parse tree.(or NodeInfo's)
out - Vector contains resulting terms (DictItems)

niFactoryDictItemTerms

public static java.util.Vector niFactoryDictItemTerms(java.util.Vector v)

niFactoryStringTermsAndPhrases

public static void niFactoryStringTermsAndPhrases(java.util.Vector v,
                                                  java.util.Vector out)
Factory method to create Vector of String symbols and phrases from query tree. (Note separator in phrases defaults to ' ')

Parameters:
v - Vector containing query parse tree.(or NodeInfo's)
out - Vector contains resulting Strings (phrases and symbols)

niFactoryStringTermsAndPhrases

public static java.util.Vector niFactoryStringTermsAndPhrases(java.util.Vector v)

niFactoryStringTermsAndPhrases

public static void niFactoryStringTermsAndPhrases(java.util.Vector v,
                                                  java.lang.String sep,
                                                  java.util.Vector out)
Factory method to create Vector of String symbols and phrases from query tree.
 NOTE: Only symbols in DRI 0 are returned.

Parameters:
v - Vector containing query parse tree. (or NodeInfo's)
sep - String separator for phrase terms.
out - Vector containing resulting Strings (phrases and symbols)